dxp-ux
listBucket (TMF654) - V2
This use case is intended to provide
- subscriber Estimate Recurring Charge and group discount from Matrixx System(PR)
- Retrieve the balances for the PA
URL
https://[localhost]:[port]/dxp-ux/v2/{businessId}/bucketURI Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR, etc.) identifying the business unit. | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Query Param
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| logicalResource.id | number | MSISDN number | Y(PA, PR) |
| partyAccount.id | number | subscription Id | Y(PR) N(PA) |
Note - For PR either 'logicalResource.id' or 'partyAccount.id' is mandatory.
Data Model-Reponse
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | string | Unique Identifier within the server for the bucket. | Y(PA), N(PR) |
| href | string | A resource URI pointing to the resource in the OB that stores the detailed information for the bucket. | Y(PA),N/A(PR) |
| name | string | Friendly name to identify the bucket. | Y(PA), N(PR) |
| @type | string | When sub-classing, this defines the sub-class Extensible name. | Y(PA), N(PR) |
| @baseType | string | When sub-classing, this defines the super-class. | Y(PA), N(PR) |
| description | string | Text describing the contents of the balance managed by the bucket. | Y(PA), N(PR) |
| usageType | string | defines the type of the underlying Balance e.g. data,voice, any currency e.g. EUR, USD etc | Y(PA), N(PR) |
| status | string | status for the bucket. active, expired, suspended. | Y(PA),N/A(PR) |
| isShared | boolean | True if the bucket is shared between several devices or users. | Y(PA), N(PR) |
| remainingValue | object | An amount in a given unit | Y(PA), N(PR) |
| remainingValue.amount | number | Numeric value in a given unit | Y(PA), N(PR) |
| remainingValue.units | string | Unit for remaining value amount | Y(PA), N(PR) |
| validFor | Object | A period of time, either as a deadline (endDateTime only) a startDateTime only, or both | N(PA), N(PR) |
| validFor.endDateTime | datetime | End of the time period | N(PA), N(PR) |
| validFor.startDateTime | datetime | Start of the time period. If you define a start, you must also define an end | N(PA), N(PR) |
| relatedParty[] | array | A list of related parties (RelatedParty [*]). Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance | N(PA),N(PR) |
| relatedParty[].id | string | unique identifier of related Party | N(PA),N(PR) |
| relatedParty[].@type | string | When sub-classing, this defines the sub-class Extensible name | N/A(PA), N(PR) |
| relatedParty[].@referredType | string | The actual type of the target instance when needed for disambiguation. | N(PA),N/A(PR) |
| logicalResource[] | array | A list of logical resource references (LogicalResourceRef [*]). reference to the LogicalResource | Y(PA), N(PR) |
| logicalResource[].id | string | unique identifier of logical Resource | Y(PA),N/A(PR) |
| logicalResource[].name | string | Name of the related entity. | N/A(PA), N(PR) |
| logicalResource[].value | string | The value of the logical resource | N/A(PA), N(PR) |
| logicalResource[].@type | string | When sub-classing, this defines the sub-class Extensible name. | Y(PA), N(PR) |
| product[] | array | A list of product references | Y(PA), N(PR) |
| product[].id | string | unique identifier of product | Y(PA), N(PR) |
| product[].name | string | Name of the product. | N/A(PA), N(PR) |
| product[].@type | string | When sub-classing, this defines the sub-class Extensible name. | N/A(PA), N(PR) |
| taxItem[] | array | Look below taxItem values for more details | N/A(PA), N(PR) |
| taxItem[].taxCategory | string | tax Category | N/A(PA), N(PR) |
| taxItem[].@type | string | tax type | N/A(PA), N(PR) |
| taxItem[].taxAmount | object | A money (Money). Tax applied. | N/A(PA), N(PR) |
| taxItem[].taxAmount.value | float | Amount of balance update | N/A(PA), N(PR) |
| taxItem[].taxAmount.unit | string | unit | N/A(PA), N(PR) |
| impactedAmount | object | Impacted Amount | N/A(PA), N(PR) |
| impactedAmount.amount | float | this is an Impact amount for Next Recharge if the customer will be on existing plan. | N/A(PA), N(PR) |
| impactedAmount.units | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N/A(PA), N(PR) |
| partyAccount | object | A party account reference (PartyAccountRef). A reference to the account that owns the bucket | N(PA), N(PR) |
| partyAccount.id | string | Unique identifier of the party account | N(PA), N(PR) |
| partyAccount.@type | string | When sub-classing, this defines the sub-class Extensible name | N/A(PA), N(PR) |
| remainingValueName | string | Remaining amount in a formatted string for the bucket given in the balance unit | Y(PA), N/A(PR) |
| @language | string | language | Y(PA), N/A(PR) |
taxItem subResource - dataModel
| taxCategory | Description | Sample |
|---|---|---|
| CITY SALES TAX | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.3 }, "taxCategory": "CITY SALES TAX", "@type": "TaxItem" }, |
| STATE SALES TAX | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.0 }, "taxCategory": "FEDERAL COST RECOVERY FEE", "@type": "TaxItem" }, |
| PR 911 SERVICE CHARGE | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.5 }, "taxCategory": "PR 911 SERVICE CHARGE", "@type": "TaxItem" }, |
| FEDERAL COST RECOVERY FEE | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.0 }, "taxCategory": "FEDERAL COST RECOVERY FEE", "@type": "TaxItem" }, |
| PUERTO RICO REGULATORY FEE | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.0 }, "taxCategory": "PUERTO RICO REGULATORY FEE", "@type": "TaxItem" }, |
| PR UNIVERSAL SERVICE FUND | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.27 }, "taxCategory": "PR UNIVERSAL SERVICE FUND", "@type": "TaxItem" }, |
| FEDERAL COST RECOVERY CHARGE | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.0 }, "taxCategory": "FEDERAL COST RECOVERY CHARGE", "@type": "TaxItem" } |
| FEDERAL UNIVERSAL SERVICE FUND | Tax name (set for tax related UpdateType only) | PR: { "taxAmount": { "unit": "USD", "value": 0.45 }, "taxCategory": "FEDERAL UNIVERSAL SERVICE FUND", "@type": "TaxItem" }, |
logicalResource subResource - dataModel
| field name | Description | Sample |
|---|---|---|
| id | Service Number | PR: { "name": "AccessNumber", "value": "09122024", "@type": "MSISDN" } PA: { "@type": "MSISDN", "id": "69877286" } |
| name | name of the logical resource | PR: { "name": "AccessNumber", "value": "09122024", "@type": "MSISDN" } |
| value | value of the logicalResource | PR: { "name": "AccessNumber", "value": "09122024", "@type": "MSISDN" } |
| '@type' | type of the logical resource, here it is "MSISDN" | PR: { "name": "AccessNumber", "value": "09122024", "@type": "MSISDN" } PA: { "@type": "MSISDN", "id": "69877286" } |
product subResource - dataModel
| field name | Description | Sample |
|---|---|---|
| id | unique identifier of product | PR: { "id": "94", "name": "Prepaid_Template_Shared", "@type": "CatalogRef" } PA: { "id": "69877286" } |
| name | Name of the product | PR: { "id": "94", "name": "Prepaid_Template_Shared", "@type": "CatalogRef" } |
| '@type | type of the product. Here it is "CatalogRef" | PR: { "id": "94", "name": "Prepaid_Template_Shared", "@type": "CatalogRef" } |
Key considerations
PA Implementation
- This is implemented for mobile prepaid customers.
- The logicalResource.id (MSISDN) input query parameter should be provided without BU code and country code.
- The bucket details will be provided from Ericsson charging system.
- Possible values for state are "Active" and "InActive".
- For all the dateTime fields
- Any datetime before 1908-04-22 will show offset -05:18
- Any datetime on or after 1908-04-22 will show offset -05:00
- Please refer the responses in following URL: DXP UX API - ListBucket